Skip to content

docs: use the dynamic README header endpoint - #209

Merged
LadyBluenotes merged 1 commit into
mainfrom
readme-header-endpoint
Aug 3, 2026
Merged

docs: use the dynamic README header endpoint#209
LadyBluenotes merged 1 commit into
mainfrom
readme-header-endpoint

Conversation

@AlemTuzlak

@AlemTuzlak AlemTuzlak commented Aug 3, 2026 •
edited by coderabbitai Bot
Loading

Copy link
Copy Markdown
Contributor

Adopts the dynamic README header endpoint added in TanStack/tanstack.com#1076,
which is merged and live.

Every README banner in this repo now points a <picture> at
https://tanstack.com/api/readme/ instead of a committed PNG. The endpoint
renders 1800x450 in light and dark, so a branding change lands in every README
at once and dark-mode readers get a dark banner.

What changed

  • 1 README(s) updated.

  • Light and dark served through <picture>, per GitHub's guidance. The trailing <img> stays the light variant, as the fallback for renderers that ignore <picture> (npm, most editors).

  • Deletes the now-unused media/header_intent.png.

Verification

Every generated URL in this diff was requested against the live endpoint and
returned 200 image/png at 1800x450. git grep confirms no README still
references the old media/header_*.png path.

Heads up: deleting the committed PNG means npm pages for already-published
versions that embed the raw.githubusercontent.com/.../main/media/header_*.png
link will show a broken image, since that link is branch-pinned. New releases
pick up the endpoint URL.

Summary by CodeRabbit

  • Documentation
    • Updated the README header image to support dark and light themes.
    • Improved image accessibility text and responsive sizing.

@coderabbitai

coderabbitai Bot commented Aug 3, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: 7871e173-d37c-4fbb-b1f0-808de7ad8acd

📥 Commits

Reviewing files that changed from the base of the PR and between 3e8f4af and acc923c.

⛔ Files ignored due to path filters (1)
  • media/header_intent.png is excluded by !**/*.png
📒 Files selected for processing (1)
  • README.md
📝 Walkthrough

Walkthrough

The README replaces its static header image with a responsive <picture> element. The element serves dark- and light-theme image URLs and includes an accessible fallback image.

Changes

README header

Layer / File(s) Summary
Responsive header image
README.md		 The README uses theme-specific remote image sources, updated alt text, and width attributes.

Estimated code review effort: 1 (Trivial) | ~2 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly identifies the main documentation change: using the dynamic README header endpoint.
Description check ✅ Passed The description clearly explains the changes, motivation, verification, and release impact, but it does not use the template headings or checklist.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch readme-header-endpoint

Warning

Review ran into problems

🔥 Problems

Git: Failed to clone repository. Please run the @coderabbitai full review command to re-trigger a full review. If the issue persists, set path_filters to include or exclude specific files.

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@nx-cloud

nx-cloud Bot commented Aug 3, 2026

Copy link
Copy Markdown

View your CI Pipeline Execution ↗ for commit acc923c

Command Status Duration Result
nx run-many --targets=build --exclude=examples/** ✅ Succeeded <1s View ↗

☁️ Nx Cloud last updated this comment at 2026-08-03 09:21:25 UTC

@LadyBluenotes
LadyBluenotes merged commit 0513f2d into main Aug 3, 2026
5 checks passed
@LadyBluenotes
LadyBluenotes deleted the readme-header-endpoint branch August 3, 2026 21:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@LadyBluenotes LadyBluenotes LadyBluenotes approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@AlemTuzlak @LadyBluenotes